/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////


#ifndef _TGUI_LOADING_BAR_INCLUDED_
#define _TGUI_LOADING_BAR_INCLUDED_

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

namespace tgui
{
    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

    struct TGUI_API LoadingBar : public OBJECT
    {
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Default constructor
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        LoadingBar();


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Copy constructor
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        LoadingBar(const LoadingBar& copy);


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Destructor
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        ~LoadingBar();


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Overload of assignment operator
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        LoadingBar& operator= (const LoadingBar& right);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// The path to the folder that contains the images.
        /// The folder must also contain an info.txt file, which will give more information about the object.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        bool load(const std::string pathname);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Changes the size of the loading bar. Note that this function will undo all scaling, as it just
        /// calculates the correct scale factors for you. It is an alternative to setScale.
        /// Note that the loading bar has to be loaded correctly before calling this function.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        void setSize(float width, float height);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the size of the loading bar, unaffected by scaling.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        Vector2u getSize() const;


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the size of the loading bar, after the scaling transformation.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        Vector2f getScaledSize() const;


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the pathname that was used to load the loading bar.
        /// When the loading bar has not been loaded yet then this function will return an empty string.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        std::string getLoadedPathname();


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Set a minimum value. When the value is too small then it will be changed to this minimum.
        ///The default minimum value is 0.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        void setMinimum(unsigned int minimum);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Set a maximum value. When the value is too big then it will be changed to this maximum.
        /// The default maximum value is 100.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        void setMaximum(unsigned int maximum);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Changes the current value. It can't be smaller than the minimum or bigger than the maximum.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        void setValue(unsigned int value);


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the minimum value, which is 0 by default.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        unsigned int getMinimum();


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the maximum value, which is 100 by default.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        unsigned int getMaximum();


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Returns the current value.
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        unsigned int getValue();


        //////////////////////////////////////////////////////////////////////////////////////////////////////
        /// Increment the value. The value can never exceed the maximum.
        ///
        /// return: the new value
        //////////////////////////////////////////////////////////////////////////////////////////////////////
        unsigned int incrementValue();


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        // This function is used to receive callback from the EventManager.
        // You normally don't need it, but you can use it to simulate an event.
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        bool mouseOnObject(float x, float y);


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    private:


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        // When the value changes, or when the minimum/maximum limits change then a smaller of bigger piece of the front image
        // must be drawn. This function is called to calculate the size of the piece to draw.
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        void recalculateSize();


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        // Because this struct is derived from sf::Drawable, you can just call the draw function from your sf::RenderTarget.
        // This function will be called and it will draw the loading bar on the render target.
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        void draw(sf::RenderTarget& target, sf::RenderStates states) const;


        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    private:

        unsigned int m_Minimum;
        unsigned int m_Maximum;
        unsigned int m_Value;

        // If this is true then the L, M and R images will be used.
        // If it is false then the button is just one big image that will be stored in the M image.
        bool m_SplitImage;

        sf::Texture* m_TextureBack_L;
        sf::Texture* m_TextureBack_M;
        sf::Texture* m_TextureBack_R;
        sf::Texture* m_TextureFront_L;
        sf::Texture* m_TextureFront_M;
        sf::Texture* m_TextureFront_R;

        sf::Sprite   m_SpriteBack_L;
        sf::Sprite   m_SpriteBack_M;
        sf::Sprite   m_SpriteBack_R;
        sf::Sprite   m_SpriteFront_L;
        sf::Sprite   m_SpriteFront_M;
        sf::Sprite   m_SpriteFront_R;

        // The pathname used to load the loading bar
        std::string m_LoadedPathname;
    };

    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#endif //_TGUI_LOADING_BAR_INCLUDED_
